<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: util/detail/sched_task_handle_state.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_23ec12649285f9fabf3a6b7380226c28.html">util</a></li><li class="navelem"><a class="el" href="dir_076e4717ccf31a1bda117b982e8d440f.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">sched_task_handle_state.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="sched__task__handle__state_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="sched__task__fwd_8hpp.html">flow/util/sched_task_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">flow/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="uniq__id__holder_8hpp.html">flow/util/uniq_id_holder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;boost/move/unique_ptr.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;boost/utility.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1util.html">flow::util</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"></span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">/**</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * Internal-use data store used by `schedule[d]_task_*()`, each object containing the state</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * relevant to a single call to either schedule_task_from_now() or schedule_task_at().  The user accesses these</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * via the opaque type util::Scheduled_task_handle which is just `shared_ptr&lt;&gt;` around this `struct`.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * Internally, it&#39;s (1) storage for the underlying util::Timer itself, the task body, etc.; (2) a simple state machine</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * with 3 possible states: `!(m_canceled || m_fired)` (initial); `m_canceled &amp;&amp; (!m_fired)` (final state 1);</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * `m_fired &amp;&amp; (!m_canceled)` (final state 2).  Obviously the state machine can only move from the initial state to</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * exactly one of the final states.  Less obviously these members must be synchronized in any multi-threaded situation.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> */</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html">   42</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structflow_1_1util_1_1Scheduled__task__handle__state.html">Scheduled_task_handle_state</a> :</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>{<span class="comment"></span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">  /// Unique ID for logging.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af99c7b9c66dc509b5d4fd9ae27ecc22b">   46</a></span><span class="comment"></span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1util_1_1Unique__id__holder.html#af9cbe2432658aac398498e0a7e96405f">Unique_id_holder::id_t</a> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af99c7b9c66dc509b5d4fd9ae27ecc22b">m_id</a>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"></span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">   * The function to execute when (and if) the timer fires, or short-fires.  Note that successful cancellation will</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">   * prevent this from being executed.  Reminder that the function takes one argument, `bool short_fire`, explained</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">   * elsewhere.  This will execute either 0 times or 1 time.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   */</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae23a4cae508bdfc5fd8316eb798e3acb">   53</a></span>  <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae23a4cae508bdfc5fd8316eb798e3acb">m_body</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"></span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment">   * Pointer to the task-executing engine (`Task_engine`) onto which to post tasks, including (if applicable) #m_body.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment">   */</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af3eb85a490f1386423fe4a6a32979a93">   58</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">Task_engine</a>* <span class="keyword">const</span> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af3eb85a490f1386423fe4a6a32979a93">m_task_engine</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"></span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">   * Mutex protecting #m_fired, #m_canceled, and #m_timer from the moment `m_timer.async_wait()` is called.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">   * Those members are safe to touch before that, as no other threads have knowledge of `this` until then.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">   * However, in `single_threaded` mode this pointer is left null, and no mutex is necessary or used (perf measure).</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">   */</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a521f4d604b987b3bd81ad8a0d0e82836">   65</a></span>  <span class="keyword">mutable</span> boost::movelib::unique_ptr&lt;Mutex_non_recursive&gt; <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a521f4d604b987b3bd81ad8a0d0e82836">m_mutex_unless_single_threaded</a>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"></span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment">   * The underlying timer object -- paired with #m_task_engine -- used to actually wait in the background and</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment">   * ultimately execute (if applicable) a wrapper around #m_body.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">   */</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a5934d785b54bb71e739c262b6db8dda9">   71</a></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ae7416d64d2989051104bb396e28e15e6">Timer</a> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a5934d785b54bb71e739c262b6db8dda9">m_timer</a>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * Flag indicating whether or not the following is true: A wrapper task around #m_body is about to fire very soon</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   * or has already been fired.  This starts `false` and, at most, can change once to `true`; in the latter case</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * #m_canceled is then guaranteed to remain `false`.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   *</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">   * It (and #m_canceled) is used as a barrier: once #m_body is on track to be immediately executed, it cannot be</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   * canceled or rescheduled; hence attempts to do so are ignored once either flag reaches `true`.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   */</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae06a06b15726040cd71d1755267d4b89">   81</a></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae06a06b15726040cd71d1755267d4b89">m_fired</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"></span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * Flag indicating whether or not the following is true: From this point on, #m_body will absolutely not be executed.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   * This starts `false` and, at most, can change once to `true`; in the latter case</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * #m_fired is then guaranteed to remain `false`.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   * It (and #m_fired) is used as a barrier: once #m_body is marked as canceled, it cannot be</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   * re-canceled or rescheduled; hence attempts to do so are ignored once either flag reaches `true`.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   */</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a2bb9de1eece77c015e23504a758b4a9f">   91</a></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a2bb9de1eece77c015e23504a758b4a9f">m_canceled</a>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"></span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   * Constructs it to the initial state, wherein it has neither fired nor been canceled.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   * @param id</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   *        See #m_id.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   * @param single_threaded</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   *        See schedule_task_from_now().</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   * @param task_engine</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   *        See schedule_task_from_now().</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * @param body_moved</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   *        See schedule_task_from_now().</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   */</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <a class="code hl_function" href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af86e69ee260b73f608ba24eef871fb88">Scheduled_task_handle_state</a>(<a class="code hl_typedef" href="classflow_1_1util_1_1Unique__id__holder.html#af9cbe2432658aac398498e0a7e96405f">Unique_id_holder::id_t</a> <span class="keywordtype">id</span>,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>                              <span class="keywordtype">bool</span> single_threaded, <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">Task_engine</a>* task_engine, <a class="code hl_class" href="classflow_1_1Function.html">Scheduled_task</a>&amp;&amp; body_moved);</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>}; <span class="comment">// struct Scheduled_task_handle_state</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>} <span class="comment">// namespace flow::util</span></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Unique__id__holder_html_af9cbe2432658aac398498e0a7e96405f"><div class="ttname"><a href="classflow_1_1util_1_1Unique__id__holder.html#af9cbe2432658aac398498e0a7e96405f">flow::util::Unique_id_holder::id_t</a></div><div class="ttdeci">uint64_t id_t</div><div class="ttdoc">Raw integer type to uniquely identify a thing. 64-bit width should make overflow extremely hard to re...</div><div class="ttdef"><b>Definition:</b> <a href="uniq__id__holder_8hpp_source.html#l00112">uniq_id_holder.hpp:112</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html"><div class="ttname"><a href="namespaceflow_1_1util.html">flow::util</a></div><div class="ttdoc">Flow module containing miscellaneous general-use facilities that don't fit into any other Flow module...</div><div class="ttdef"><b>Definition:</b> <a href="basic__blob_8hpp_source.html#l00028">basic_blob.hpp:29</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ac3e89a8a271b0ddc76ac2a0ce488dea4"><div class="ttname"><a href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_context Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ae7416d64d2989051104bb396e28e15e6"><div class="ttname"><a href="namespaceflow_1_1util.html#ae7416d64d2989051104bb396e28e15e6">flow::util::Timer</a></div><div class="ttdeci">boost::asio::basic_waitable_timer&lt; Fine_clock &gt; Timer</div><div class="ttdoc">boost.asio timer.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00202">util_fwd.hpp:202</a></div></div>
<div class="ttc" id="asched__task__fwd_8hpp_html"><div class="ttname"><a href="sched__task__fwd_8hpp.html">sched_task_fwd.hpp</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html">flow::util::Scheduled_task_handle_state</a></div><div class="ttdoc">Internal-use data store used by schedule[d]_task_*(), each object containing the state relevant to a ...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00042">sched_task_handle_state.hpp:44</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_a2bb9de1eece77c015e23504a758b4a9f"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a2bb9de1eece77c015e23504a758b4a9f">flow::util::Scheduled_task_handle_state::m_canceled</a></div><div class="ttdeci">bool m_canceled</div><div class="ttdoc">Flag indicating whether or not the following is true: From this point on, m_body will absolutely not ...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00091">sched_task_handle_state.hpp:91</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_a521f4d604b987b3bd81ad8a0d0e82836"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a521f4d604b987b3bd81ad8a0d0e82836">flow::util::Scheduled_task_handle_state::m_mutex_unless_single_threaded</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Mutex_non_recursive &gt; m_mutex_unless_single_threaded</div><div class="ttdoc">Mutex protecting m_fired, m_canceled, and m_timer from the moment m_timer.async_wait() is called.</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00065">sched_task_handle_state.hpp:65</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_a5934d785b54bb71e739c262b6db8dda9"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#a5934d785b54bb71e739c262b6db8dda9">flow::util::Scheduled_task_handle_state::m_timer</a></div><div class="ttdeci">Timer m_timer</div><div class="ttdoc">The underlying timer object – paired with m_task_engine – used to actually wait in the background and...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00071">sched_task_handle_state.hpp:71</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_ae06a06b15726040cd71d1755267d4b89"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae06a06b15726040cd71d1755267d4b89">flow::util::Scheduled_task_handle_state::m_fired</a></div><div class="ttdeci">bool m_fired</div><div class="ttdoc">Flag indicating whether or not the following is true: A wrapper task around m_body is about to fire v...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00081">sched_task_handle_state.hpp:81</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_ae23a4cae508bdfc5fd8316eb798e3acb"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#ae23a4cae508bdfc5fd8316eb798e3acb">flow::util::Scheduled_task_handle_state::m_body</a></div><div class="ttdeci">const Scheduled_task m_body</div><div class="ttdoc">The function to execute when (and if) the timer fires, or short-fires.</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00053">sched_task_handle_state.hpp:53</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_af3eb85a490f1386423fe4a6a32979a93"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af3eb85a490f1386423fe4a6a32979a93">flow::util::Scheduled_task_handle_state::m_task_engine</a></div><div class="ttdeci">Task_engine *const m_task_engine</div><div class="ttdoc">Pointer to the task-executing engine (Task_engine) onto which to post tasks, including (if applicable...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00058">sched_task_handle_state.hpp:58</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_af86e69ee260b73f608ba24eef871fb88"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af86e69ee260b73f608ba24eef871fb88">flow::util::Scheduled_task_handle_state::Scheduled_task_handle_state</a></div><div class="ttdeci">Scheduled_task_handle_state(Unique_id_holder::id_t id, bool single_threaded, Task_engine *task_engine, Scheduled_task &amp;&amp;body_moved)</div><div class="ttdoc">Constructs it to the initial state, wherein it has neither fired nor been canceled.</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8cpp_source.html#l00027">sched_task_handle_state.cpp:27</a></div></div>
<div class="ttc" id="astructflow_1_1util_1_1Scheduled__task__handle__state_html_af99c7b9c66dc509b5d4fd9ae27ecc22b"><div class="ttname"><a href="structflow_1_1util_1_1Scheduled__task__handle__state.html#af99c7b9c66dc509b5d4fd9ae27ecc22b">flow::util::Scheduled_task_handle_state::m_id</a></div><div class="ttdeci">const Unique_id_holder::id_t m_id</div><div class="ttdoc">Unique ID for logging.</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__handle__state_8hpp_source.html#l00046">sched_task_handle_state.hpp:46</a></div></div>
<div class="ttc" id="auniq__id__holder_8hpp_html"><div class="ttname"><a href="uniq__id__holder_8hpp.html">uniq_id_holder.hpp</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
